tempiso.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2026 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/

 
#ifndef TEMPISO_H
#define TEMPISO_H
 
#ifdef __cplusplus
extern "C"{
#endif

#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_analog_in.h"




#define TEMPISO_NUM_CONVERSIONS         100

#define TEMPISO_VREF_3V3                3.3
#define TEMPISO_VREF_5V                 5.0

#define TEMPISO_TIMEOUT_MS              2000

#define TEMPISO_TEMP_SENS_V_PER_C       0.01f
#define TEMPISO_TEMP_ZERO_OFFSET_V      0.5f
 // tempiso_set



#define TEMPISO_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN );
 // tempiso_map // tempiso

typedef struct
{
    analog_in_t adc;        
 
} tempiso_t;

typedef struct
{
    pin_name_t an;          
 
    analog_in_resolution_t resolution;  
    float                  vref;        
 
} tempiso_cfg_t;

typedef enum
{
    TEMPISO_OK = 0,
    TEMPISO_ERROR = -1
 
} tempiso_return_value_t;


void tempiso_cfg_setup ( tempiso_cfg_t *cfg );

err_t tempiso_init ( tempiso_t *ctx, tempiso_cfg_t *cfg );

err_t tempiso_read_raw_adc ( tempiso_t *ctx, uint16_t *raw_adc );

err_t tempiso_read_voltage ( tempiso_t *ctx, float *voltage );

err_t tempiso_read_voltage_avg ( tempiso_t *ctx, uint16_t num_conv, float *voltage_avg );

err_t tempiso_set_vref ( tempiso_t *ctx, float vref );

err_t tempiso_read_temperature ( tempiso_t *ctx, float *data_out );
 
#ifdef __cplusplus
}
#endif
#endif // TEMPISO_H
 // tempiso
 
// ------------------------------------------------------------------------ END